<?php
/**     
  *
  * Copyright (c) 2009, Persistent Systems Limited
  *
  * Redistribution and use, with or without modification, are permitted 
  *  provided that the following  conditions are met:
  *   - Redistributions of source code must retain the above copyright notice, 
  *     this list of conditions and the following disclaimer.
  *   - Neither the name of Persistent Systems Limited nor the names of its contributors 
  *     may be used to endorse or promote products derived from this software 
  *     without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
  
/**
  *
  * This file contains the definition of EntityStates Class (used as enum)
  */
/**
  * The EntityStates Class.
  * 
  * This class defines constants which is used to represents state of entity instances
  * during object tracking.
  *  
  */
class EntityStates
{
    /**
     * Used to indicate a new entity has been added (using AddObject) or
     * a new link has been created (using AddLink)
     */
     
    const Added = '1';
    
    /**
     * Used to indicate an entity has been deleted (using DeleteObject) or
     * a link has been deleted (using DeleteLink)
     */
     
    const Deleted = '2';
    
    /**
     * Used to indicate a link has been detached (when we delete an object using 
     * DeleteObject all assoicated links added using AddLink should be released
     * and its status should be set to Detached)
     */
     
    const Detached = '3';
    
    /**
     * Used to indicate an entity has been modified (using UpdateObject)
     */
     
    const Modified = '4';
    
    /**
     * Used to indicate the entity has not yet changed (when we perform any query
     * execution the resultant entities will be in  Unchanged state).
     */
    const Unchanged = '5';
}
?>
